ClientOptions["cloud"] should have optional auth fields #1032
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This changes the optional username and password under `cloud` to actually be optional.
```diff
cloud?: {
id: string;
// TODO: remove username and password here in 8
- username: string;
- password: string;
+ username?: string;
+ password?: string;
}
```
This lets the documented workflow where the `cloud.id` is specified along with traditional `auth` work in TypeScript without cheating. The workaround to it is:
```ts
return new Client({
cloud: {
id: env.CLOUD_ID,
} as ClientOptions['cloud'], // note: in 7.5.0 it has the optional user/pass as not optional
auth: {
username: env.USERNAME,
password: env.PASSWORD,
},
});
```
delvedor
pushed a commit
that referenced
this pull request
Jan 7, 2020
delvedor
pushed a commit
that referenced
this pull request
Jan 7, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This changes the optional username and password under
cloudto actually be optional.cloud?: { id: string; // TODO: remove username and password here in 8 - username: string; - password: string; + username?: string; + password?: string; }This lets the documented workflow where the
cloud.idis specified along with traditionalauthwork in TypeScript without cheating.Prior to this PR, the workaround is: